
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>particle_size_models.ModelBase.simulate &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
    <script src="../../_static/jquery.js"></script>
    <script src="../../_static/underscore.js"></script>
    <script src="../../_static/doctools.js"></script>
    <script src="../../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../../genindex.html" />
    <link rel="search" title="Search" href="../../search.html" />
    <link rel="next" title="particle_size_models.ModelBase.update_properties" href="particle_size_models.ModelBase.update_properties.html" />
    <link rel="prev" title="particle_size_models.ModelBase.plot_psd" href="particle_size_models.ModelBase.plot_psd.html" />
   
  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="particle-size-models-modelbase-simulate">
<h1>particle_size_models.ModelBase.simulate<a class="headerlink" href="#particle-size-models-modelbase-simulate" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="particle_size_models.ModelBase.simulate">
<code class="sig-prename descclassname">ModelBase.</code><code class="sig-name descname">simulate</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">d0</em>, <em class="sig-param">m_gas</em>, <em class="sig-param">m_oil</em>, <em class="sig-param">model_gas='wang_etal'</em>, <em class="sig-param">model_oil='sintef'</em>, <em class="sig-param">pdf_gas='lognormal'</em>, <em class="sig-param">pdf_oil='rosin-rammler'</em>, <em class="sig-param">Pa=4000000.0</em>, <em class="sig-param">Ta=288.15</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/particle_size_models.html#ModelBase.simulate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#particle_size_models.ModelBase.simulate" title="Permalink to this definition">¶</a></dt>
<dd><p>Compute the parameters of the particle size distribution</p>
<p>Computes the median bubble and droplet sizes and the spread
of the selected size distributions.  Models for gas bubble median
size are <cite>wang_etal</cite> or <cite>li_etal</cite>; models for oil droplet median
size are <cite>sintef</cite> or <cite>li_etal</cite>.  Size distributions are either
<cite>lognormal</cite> or <cite>rosin-rammler</cite>.  No matter what model is selected,
the <cite>d_95</cite>-rule is used when the predicted size distribution would
exceed the maximum stable bubble or droplet size.  Under that rule,
the 95-percentile of the volume size distribution is set to the
maximum stable size, and the median size is adjusted downward.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>d0</strong><span class="classifier">float</span></dt><dd><p>Equivalent circular diameter of the release orifice (m)</p>
</dd>
<dt><strong>m_gas</strong><span class="classifier">float</span></dt><dd><p>Mass flow rate of gas released from the jet (kg/s)</p>
</dd>
<dt><strong>m_oil</strong><span class="classifier">float</span></dt><dd><p>Mass flow rate of liquid released from the jet (kg/s)</p>
</dd>
<dt><strong>model_gas</strong><span class="classifier">str, default=’wang_etal’</span></dt><dd><p>Name of the model used for computing the gas bubble size
distribution.  Choices are ‘wang_etal’ or ‘li_etal’:.</p>
</dd>
<dt><strong>model_oil</strong><span class="classifier">str, default=’sintef’</span></dt><dd><p>Name of the model used for computing the oil droplet size
distribution.  Choices are ‘sintef’ or ‘li_etal’.</p>
</dd>
<dt><strong>pdf_gas</strong><span class="classifier">str, default=’lognormal’</span></dt><dd><p>Probability density function to use for the gas bubble size
distribution.  Choices are ‘lognormal’ or ‘rosin-rammler’.</p>
</dd>
<dt><strong>pdf_oil</strong><span class="classifier">str, default=’rosin-rammler’</span></dt><dd><p>Probability density function to use for the oil droplet size
distribution.  Choices are ‘lognormal’ or ‘rosin-rammler’.</p>
</dd>
<dt><strong>Pa</strong><span class="classifier">float, default=4.e6</span></dt><dd><p>Pressure at the release point.  Used to compute the speed of
sound in gas.</p>
</dd>
<dt><strong>Ta</strong><span class="classifier">float, default=288.15</span></dt><dd><p>Temperature of the released fluids.  Used to compute the
speed of sound of gas.</p>
</dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="particle_size_models.ModelBase.get_d50.html#particle_size_models.ModelBase.get_d50" title="particle_size_models.ModelBase.get_d50"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_d50</span></code></a>, <a class="reference internal" href="particle_size_models.ModelBase.get_de_max.html#particle_size_models.ModelBase.get_de_max" title="particle_size_models.ModelBase.get_de_max"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_de_max</span></code></a>, <a class="reference internal" href="particle_size_models.ModelBase.get_distributions.html#particle_size_models.ModelBase.get_distributions" title="particle_size_models.ModelBase.get_distributions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_distributions</span></code></a></dt><dd></dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>This method does not return any values.  Instead, the computed values
are stored as attributes of the class object.  To report the computed
values, use the <cite>get</cite>-methods.</p>
</dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../index.html">Documentation overview</a><ul>
  <li><a href="../../user_manual.html">TAMOC User Manual</a><ul>
  <li><a href="../../modules/particle_size_models.html">Overview of Particle Size Models Module</a><ul>
  <li><a href="particle_size_models.ModelBase.html">particle_size_models.ModelBase</a><ul>
      <li>Previous: <a href="particle_size_models.ModelBase.plot_psd.html" title="previous chapter">particle_size_models.ModelBase.plot_psd</a></li>
      <li>Next: <a href="particle_size_models.ModelBase.update_properties.html" title="next chapter">particle_size_models.ModelBase.update_properties</a></li>
  </ul></li>
  </ul></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../_sources/autodoc/psd/particle_size_models.ModelBase.simulate.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>